<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">

<title>module Timeout - timeout: Ruby Standard Library Documentation</title>


<script src="./js/navigation.js" defer></script>
<script src="./js/search.js" defer></script>
<script src="./js/search_index.js" defer></script>
<script src="./js/searcher.js" defer></script>
<script src="./js/darkfish.js" defer></script>

<script src="./js/jquery-3.2.0.min.js"></script>

<script src="./js/vue.min.js"></script>
<script src="./js/js.cookie.min.js"></script>

<link href="./css/fonts.css" rel="stylesheet">
<link id='rdoccss' href="./css/rdoc.css" rel="stylesheet">
<link href="./css/carbon17.css" rel="stylesheet">

<script type="text/javascript">
  var rdoc_rel_prefix = "./";
  var index_rel_prefix = "./";
  var darkModeCsseHref = "./css/rdoc-dm.css"
  var defaultModeCssHref = "./css/rdoc.css"
  // var cssDarkmode = Cookies.get('darkmode');
  
  if( Cookies.get("darkmode") == "true") {
	$('#rdoccss').attr("href", darkModeCsseHref);
}

//  https://cssdeck.com/blog/simple-jquery-stylesheet-switcher/

document.write('<style type="text/css">body{display:none}</style>');

</script>


</head>
<body id="top" role="document" class="module">
  <!-- this is class.html -->

  <div id='actionbar' >
    <div class='wrapper mdiv'>
      <ul class='grids g0'></ul>
    </div> 
    <!-- VERSION HEADER for 3.3.0.preview2 NOT FOUND -->
  </div> <!-- end action bar -->

  <div class='wrapper hdiv'>

    


    <nav id='vapp' role="navigation">
    <div id="project-navigation">
      <div id="home-section" role="region" title="Quick navigation" class="nav-section">
  <h2><a href="./index.html" rel="home">Home</a></h2>

  <div id="table-of-contents-navigation"  >
    <a href="./table_of_contents.html#pages">Pages</a>
    <a href="./table_of_contents.html#classes">Classes</a>
    <a href="./table_of_contents.html#methods">Methods</a>
  </div>
</div>

      <div id="search-section" role="search" class="project-section initially-hidden">
  <form action="#" method="get" accept-charset="utf-8">
    <div id="search-field-wrapper">
      <input id="search-field" role="combobox" aria-label="Search"
             aria-autocomplete="list" aria-controls="search-results"
             type="text" name="search" placeholder="Search" spellcheck="false"
             title="Type to search, Up and Down to navigate, Enter to load">
    </div>

    <ul id="search-results" aria-label="Search Results"
        aria-busy="false" aria-expanded="false"
        aria-atomic="false" class="initially-hidden"></ul>
  </form>
</div>

    </div>


    
<div class="nav-section">
  <h3>Table of Contents</h3>

  <ul class="link-list" role="directory">
    <li><a href="#module-Timeout-label-Synopsis">Synopsis</a>
    <li><a href="#module-Timeout-label-Description">Description</a>
    <li><a href="#module-Timeout-label-Copyright">Copyright</a>
  </ul>
</div>


    <button id='toggleThing' @click="toggleNav()" >Show/hide navigation</button>
    <div :class="isOpen ? 'block' : 'hidden' " id='toggleMe'>
      <div id="class-metadata">
        
        
        
        
        
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
  <h3>Methods</h3>

  <ul class="link-list" role="directory">
    <li ><a href="#method-c-timeout">::timeout</a>
    <li ><a href="#method-i-timeout">#timeout</a>
  </ul>
</div>

      </div>
     </div>
    </nav>


    <div id='extraz'><div class='adzbox-index'  >
      
     </div>         
    </div>

    <main role="main" aria-labelledby="module-Timeout">
    <h1 id="module-Timeout" class="module">
      module Timeout
    </h1>

    <section class="description">
    
<p><a href="Timeout.html"><code>Timeout</code></a> long-running blocks</p>

<h2 id="module-Timeout-label-Synopsis">Synopsis<span><a href="#module-Timeout-label-Synopsis">&para;</a> <a href="#top">&uarr;</a></span></h2>

<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">&#39;timeout&#39;</span>
<span class="ruby-identifier">status</span> = <span class="ruby-constant">Timeout</span><span class="ruby-operator">::</span><span class="ruby-identifier">timeout</span>(<span class="ruby-value">5</span>) {
  <span class="ruby-comment"># Something that should be interrupted if it takes more than 5 seconds...</span>
}
</pre>

<h2 id="module-Timeout-label-Description">Description<span><a href="#module-Timeout-label-Description">&para;</a> <a href="#top">&uarr;</a></span></h2>

<p><a href="Timeout.html"><code>Timeout</code></a> provides a way to auto-terminate a potentially long-running operation if it hasn’t finished in a fixed amount of time.</p>

<p>Previous versions didn’t use a module for namespacing, however <a href="Timeout.html#method-i-timeout"><code>timeout</code></a> is provided for backwards compatibility.  You should prefer <a href="Timeout.html#method-c-timeout"><code>Timeout.timeout</code></a> instead.</p>

<h2 id="module-Timeout-label-Copyright">Copyright<span><a href="#module-Timeout-label-Copyright">&para;</a> <a href="#top">&uarr;</a></span></h2>
<dl class="rdoc-list note-list"><dt>Copyright
<dd>
<p>© 2000  Network Applied Communication Laboratory, Inc.</p>
</dd><dt>Copyright
<dd>
<p>© 2000  Information-technology Promotion Agency, Japan</p>
</dd></dl>

    </section>

      <section id="5Buntitled-5D" class="documentation-section">


      <section class="constants-list">
      <header>
      <h3>Constants</h3>
      </header>
      <dl>
          <dt id="VERSION">VERSION
          <dd>
        </dl>
        </section>



                <section id="public-class-5Buntitled-5D-method-details" class="method-section">
                <header>
                <h3>Public Class Methods</h3>
                </header>

                  <div id="method-c-timeout" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">timeout</span><span
                                class="method-args">(sec, klass = nil, message = nil) { |sec| ... }</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              <p>Perform an operation in a block, raising an error if it takes longer than <code>sec</code> seconds to complete.</p>
<dl class="rdoc-list note-list"><dt><code>sec</code>
<dd>
<p>Number of seconds to wait for the block to terminate. Any number may be used, including Floats to specify fractional seconds. A value of 0 or <code>nil</code> will execute the block without any timeout.</p>
</dd><dt><code>klass</code>
<dd>
<p>Exception Class to raise if the block fails to terminate in <code>sec</code> seconds.  Omitting will use the default, <a href="Timeout/Error.html"><code>Timeout::Error</code></a></p>
</dd><dt><code>message</code>
<dd>
<p><a href="Timeout/Error.html"><code>Error</code></a> message to raise with Exception Class. Omitting will use the default, “execution expired”</p>
</dd></dl>

<p>Returns the result of the block <strong>if</strong> the block completed before <code>sec</code> seconds, otherwise throws an exception, based on the value of <code>klass</code>.</p>

<p>The exception thrown to terminate the given block cannot be rescued inside the block unless <code>klass</code> is given explicitly. However, the block can use ensure to prevent the handling of the exception.  For that reason, this method cannot be relied on to enforce timeouts for untrusted blocks.</p>

<p>If a scheduler is defined, it will be used to handle the timeout by invoking Scheduler#timeout_after.</p>

<p>Note that this is both a method of module <a href="Timeout.html"><code>Timeout</code></a>, so you can <code>include Timeout</code> into your classes so they have a <a href="Timeout.html#method-i-timeout"><code>timeout</code></a> method, as well as a module method, so you can call it directly as <a href="Timeout.html#method-c-timeout"><code>Timeout.timeout()</code></a>.</p>

                              <div class="method-source-code" id="timeout-source">
            <pre><span class="ruby-comment"># File timeout.rb, line 169</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">timeout</span>(<span class="ruby-identifier">sec</span>, <span class="ruby-identifier">klass</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">message</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)   <span class="ruby-comment">#:yield: +sec+</span>
  <span class="ruby-keyword">return</span> <span class="ruby-keyword">yield</span>(<span class="ruby-identifier">sec</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">sec</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">or</span> <span class="ruby-identifier">sec</span>.<span class="ruby-identifier">zero?</span>

  <span class="ruby-identifier">message</span> <span class="ruby-operator">||=</span> <span class="ruby-string">&quot;execution expired&quot;</span>

  <span class="ruby-keyword">if</span> <span class="ruby-constant">Fiber</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:current_scheduler</span>) <span class="ruby-operator">&amp;&amp;</span> (<span class="ruby-identifier">scheduler</span> = <span class="ruby-constant">Fiber</span>.<span class="ruby-identifier">current_scheduler</span>)&amp;.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:timeout_after</span>)
    <span class="ruby-keyword">return</span> <span class="ruby-identifier">scheduler</span>.<span class="ruby-identifier">timeout_after</span>(<span class="ruby-identifier">sec</span>, <span class="ruby-identifier">klass</span> <span class="ruby-operator">||</span> <span class="ruby-constant">Error</span>, <span class="ruby-identifier">message</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
  <span class="ruby-keyword">end</span>

  <span class="ruby-constant">Timeout</span>.<span class="ruby-identifier">ensure_timeout_thread_created</span>
  <span class="ruby-identifier">perform</span> = <span class="ruby-constant">Proc</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">exc</span><span class="ruby-operator">|</span>
    <span class="ruby-identifier">request</span> = <span class="ruby-constant">Request</span>.<span class="ruby-identifier">new</span>(<span class="ruby-constant">Thread</span>.<span class="ruby-identifier">current</span>, <span class="ruby-identifier">sec</span>, <span class="ruby-identifier">exc</span>, <span class="ruby-identifier">message</span>)
    <span class="ruby-constant">QUEUE_MUTEX</span>.<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword">do</span>
      <span class="ruby-constant">QUEUE</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">request</span>
      <span class="ruby-constant">CONDVAR</span>.<span class="ruby-identifier">signal</span>
    <span class="ruby-keyword">end</span>
    <span class="ruby-keyword">begin</span>
      <span class="ruby-keyword">return</span> <span class="ruby-keyword">yield</span>(<span class="ruby-identifier">sec</span>)
    <span class="ruby-keyword">ensure</span>
      <span class="ruby-identifier">request</span>.<span class="ruby-identifier">finished</span>
    <span class="ruby-keyword">end</span>
  <span class="ruby-keyword">end</span>

  <span class="ruby-keyword">if</span> <span class="ruby-identifier">klass</span>
    <span class="ruby-identifier">perform</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">klass</span>)
  <span class="ruby-keyword">else</span>
    <span class="ruby-constant">Error</span>.<span class="ruby-identifier">handle_timeout</span>(<span class="ruby-identifier">message</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">perform</span>)
  <span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                          </section>

                <section id="private-instance-5Buntitled-5D-method-details" class="method-section">
                <header>
                <h3>Private Instance Methods</h3>
                </header>

                  <div id="method-i-timeout" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">timeout</span><span
                                class="method-args">(sec, klass = nil, message = nil) { |sec| ... }</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              <p>Perform an operation in a block, raising an error if it takes longer than <code>sec</code> seconds to complete.</p>
<dl class="rdoc-list note-list"><dt><code>sec</code>
<dd>
<p>Number of seconds to wait for the block to terminate. Any number may be used, including Floats to specify fractional seconds. A value of 0 or <code>nil</code> will execute the block without any timeout.</p>
</dd><dt><code>klass</code>
<dd>
<p>Exception Class to raise if the block fails to terminate in <code>sec</code> seconds.  Omitting will use the default, <a href="Timeout/Error.html"><code>Timeout::Error</code></a></p>
</dd><dt><code>message</code>
<dd>
<p><a href="Timeout/Error.html"><code>Error</code></a> message to raise with Exception Class. Omitting will use the default, “execution expired”</p>
</dd></dl>

<p>Returns the result of the block <strong>if</strong> the block completed before <code>sec</code> seconds, otherwise throws an exception, based on the value of <code>klass</code>.</p>

<p>The exception thrown to terminate the given block cannot be rescued inside the block unless <code>klass</code> is given explicitly. However, the block can use ensure to prevent the handling of the exception.  For that reason, this method cannot be relied on to enforce timeouts for untrusted blocks.</p>

<p>If a scheduler is defined, it will be used to handle the timeout by invoking Scheduler#timeout_after.</p>

<p>Note that this is both a method of module <a href="Timeout.html"><code>Timeout</code></a>, so you can <code>include Timeout</code> into your classes so they have a <a href="Timeout.html#method-i-timeout"><code>timeout</code></a> method, as well as a module method, so you can call it directly as <a href="Timeout.html#method-c-timeout"><code>Timeout.timeout()</code></a>.</p>

                              <div class="method-source-code" id="timeout-source">
            <pre><span class="ruby-comment"># File timeout.rb, line 169</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">timeout</span>(<span class="ruby-identifier">sec</span>, <span class="ruby-identifier">klass</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">message</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)   <span class="ruby-comment">#:yield: +sec+</span>
  <span class="ruby-keyword">return</span> <span class="ruby-keyword">yield</span>(<span class="ruby-identifier">sec</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">sec</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">or</span> <span class="ruby-identifier">sec</span>.<span class="ruby-identifier">zero?</span>

  <span class="ruby-identifier">message</span> <span class="ruby-operator">||=</span> <span class="ruby-string">&quot;execution expired&quot;</span>

  <span class="ruby-keyword">if</span> <span class="ruby-constant">Fiber</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:current_scheduler</span>) <span class="ruby-operator">&amp;&amp;</span> (<span class="ruby-identifier">scheduler</span> = <span class="ruby-constant">Fiber</span>.<span class="ruby-identifier">current_scheduler</span>)&amp;.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:timeout_after</span>)
    <span class="ruby-keyword">return</span> <span class="ruby-identifier">scheduler</span>.<span class="ruby-identifier">timeout_after</span>(<span class="ruby-identifier">sec</span>, <span class="ruby-identifier">klass</span> <span class="ruby-operator">||</span> <span class="ruby-constant">Error</span>, <span class="ruby-identifier">message</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
  <span class="ruby-keyword">end</span>

  <span class="ruby-constant">Timeout</span>.<span class="ruby-identifier">ensure_timeout_thread_created</span>
  <span class="ruby-identifier">perform</span> = <span class="ruby-constant">Proc</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">exc</span><span class="ruby-operator">|</span>
    <span class="ruby-identifier">request</span> = <span class="ruby-constant">Request</span>.<span class="ruby-identifier">new</span>(<span class="ruby-constant">Thread</span>.<span class="ruby-identifier">current</span>, <span class="ruby-identifier">sec</span>, <span class="ruby-identifier">exc</span>, <span class="ruby-identifier">message</span>)
    <span class="ruby-constant">QUEUE_MUTEX</span>.<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword">do</span>
      <span class="ruby-constant">QUEUE</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">request</span>
      <span class="ruby-constant">CONDVAR</span>.<span class="ruby-identifier">signal</span>
    <span class="ruby-keyword">end</span>
    <span class="ruby-keyword">begin</span>
      <span class="ruby-keyword">return</span> <span class="ruby-keyword">yield</span>(<span class="ruby-identifier">sec</span>)
    <span class="ruby-keyword">ensure</span>
      <span class="ruby-identifier">request</span>.<span class="ruby-identifier">finished</span>
    <span class="ruby-keyword">end</span>
  <span class="ruby-keyword">end</span>

  <span class="ruby-keyword">if</span> <span class="ruby-identifier">klass</span>
    <span class="ruby-identifier">perform</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">klass</span>)
  <span class="ruby-keyword">else</span>
    <span class="ruby-constant">Error</span>.<span class="ruby-identifier">handle_timeout</span>(<span class="ruby-identifier">message</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">perform</span>)
  <span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                          </section>

              </section>
              </main>



            </div>  <!--  class='wrapper hdiv' -->


<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a></p>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.4.0.</p>
<p>Based on <a href="https://github.com/ged/darkfish/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.</p>

  
    <p><p><a href="https://ruby-doc.org">Ruby-doc.org</a> is provided by <a href="https://jamesbritt.com">James Britt</a> and <a href="https://neurogami.com">Neurogami</a>. </p><p><a href="https://jamesbritt.bandcamp.com/">Hack your world.  Feed your head.  Live curious</a>.</p>
</p>
  
  </footer>

<script type="text/javascript">


  let ads  = $("#carbonads-container").children().detach();


  function swapMode() {
    var cookieName = 'darkmode';
    var cssDarkmode = Cookies.get(cookieName);
    console.log("***** swapMode! " + cssDarkmode + " *****");


    if (cssDarkmode == "true") {
      console.log("We have dark mode, set the css to light ...");
      $('#rdoccss').attr("href", defaultModeCssHref);
      $('#cssSelect').text("Dark mode");
      cssDarkmode = "false";
      console.log("swapMode! Now set cookie to " + cssDarkmode);
      Cookies.set(cookieName, cssDarkmode);

    } else {
      console.log("We not have dark mode, set the css to dark ...");
      $('#rdoccss').attr("href", darkModeCsseHref);
      $('#cssSelect').text("Light mode");
      cssDarkmode = "true";
      console.log("swapMode! Now set cookie to " + cssDarkmode);
      Cookies.set(cookieName, cssDarkmode);

    }

    console.log("  --------------- ");
  }


const vueCssApp = new Vue({
el: '#menubar',
data: {
isDark: false
},
methods: {
toggleClass: function(event){
this.isDark = !this.isDark;
}
}
})

const vueApp = new Vue({
el: '#vapp',
data: { 
isOpen: true
},

mounted() {
this.handleResize();
this.manage_mob_classes();
window.addEventListener('resize', this.handleResize)
//this.isOpen !=  (/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent));
},
destroyed() {
window.removeEventListener('resize', this.handleResize)
},
created() {
//manage_mob_classes();
},

methods : {
isMobile() {
  return (/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent));
},

  handleResize() {
    if (!this.isMobile()) {
      this.isOpen = window.innerWidth > 800;
    }
  },

  manage_mob_classes() {
    if (/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent)) {
      $("nav").addClass("mob_nav");
      $("main").addClass("mob_main");
      $("#extraz").addClass("mob_extraz");
      $("#carbonads-container").addClass("mob_carbonads-container");
      this.isOpen  = false;
    } else {
      $("nav").removeClass("mob_nav") 
        $("main").removeClass("mob_main");
      $("#extraz").removeClass("mob_extraz");
      $("#carbonads-container").removeClass("mob_carbonads-container");
      this.isOpen  = true;
    }
  },

  toggleNav() {
    this.isOpen =! this.isOpen ;
    // alert("Toggle nav!");
    console.log("toggleNav() click: " + this.isOpen );
  }
}
})

$("#carbonads-container").append(ads);


$(function() {

    var darkmode = Cookies.get("darkmode");
    console.log("Document ready: " + darkmode);

    if ( darkmode  == "true" ) {
      $('#cssSelect').text("Light mode");
    } else {
      $('#cssSelect').text("Dark mode");
     }

    $('body').css('display','block');
    });

</script>

    
  </body> 
</html>

